<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>uartpsv: XUartPsv Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">uartpsv
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_uart_psv.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XUartPsv Struct Reference<div class="ingroups"><a class="el" href="group__uartpsv.html">Overview</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="struct_x_uart_psv.html" title="The XUartPsv driver instance data structure. ">XUartPsv</a> driver instance data structure.  
 <a href="struct_x_uart_psv.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a28f121775b342f18caae6f39331d1079"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_psv___config.html">XUartPsv_Config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#a28f121775b342f18caae6f39331d1079">Config</a></td></tr>
<tr class="memdesc:a28f121775b342f18caae6f39331d1079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration data structure.  <a href="#a28f121775b342f18caae6f39331d1079">More...</a><br/></td></tr>
<tr class="separator:a28f121775b342f18caae6f39331d1079"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a839fe00b54572bef26f9ecda4bd2a471"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#a839fe00b54572bef26f9ecda4bd2a471">InputClockHz</a></td></tr>
<tr class="memdesc:a839fe00b54572bef26f9ecda4bd2a471"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input clock frequency.  <a href="#a839fe00b54572bef26f9ecda4bd2a471">More...</a><br/></td></tr>
<tr class="separator:a839fe00b54572bef26f9ecda4bd2a471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dd385478a1d6f6dcbff3d0642ac1904"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#a4dd385478a1d6f6dcbff3d0642ac1904">IsReady</a></td></tr>
<tr class="memdesc:a4dd385478a1d6f6dcbff3d0642ac1904"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device is initialized and ready.  <a href="#a4dd385478a1d6f6dcbff3d0642ac1904">More...</a><br/></td></tr>
<tr class="separator:a4dd385478a1d6f6dcbff3d0642ac1904"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ac2e57dee932612cdc9eed25f025955"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#a4ac2e57dee932612cdc9eed25f025955">BaudRate</a></td></tr>
<tr class="memdesc:a4ac2e57dee932612cdc9eed25f025955"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current baud rate.  <a href="#a4ac2e57dee932612cdc9eed25f025955">More...</a><br/></td></tr>
<tr class="separator:a4ac2e57dee932612cdc9eed25f025955"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52503eea4d30a82b0036bf8ee40980a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_psv_buffer.html">XUartPsvBuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#a52503eea4d30a82b0036bf8ee40980a2">SendBuffer</a></td></tr>
<tr class="memdesc:a52503eea4d30a82b0036bf8ee40980a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to hold tx data.  <a href="#a52503eea4d30a82b0036bf8ee40980a2">More...</a><br/></td></tr>
<tr class="separator:a52503eea4d30a82b0036bf8ee40980a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeee14c65e38a5fa3dc2eeaf6d60281ab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_uart_psv_buffer.html">XUartPsvBuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#aeee14c65e38a5fa3dc2eeaf6d60281ab">ReceiveBuffer</a></td></tr>
<tr class="memdesc:aeee14c65e38a5fa3dc2eeaf6d60281ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Buffer to hold rx data.  <a href="#aeee14c65e38a5fa3dc2eeaf6d60281ab">More...</a><br/></td></tr>
<tr class="separator:aeee14c65e38a5fa3dc2eeaf6d60281ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa64939340dd16487202fa1cc9a0af657"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__uartpsv.html#gab83b4279762a2b3f20b1c50998a709d3">XUartPsv_Handler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#aa64939340dd16487202fa1cc9a0af657">Handler</a></td></tr>
<tr class="memdesc:aa64939340dd16487202fa1cc9a0af657"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function ptr to hold user handler.  <a href="#aa64939340dd16487202fa1cc9a0af657">More...</a><br/></td></tr>
<tr class="separator:aa64939340dd16487202fa1cc9a0af657"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af86e00e608392fe594cb87d10dd3686e"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_uart_psv.html#af86e00e608392fe594cb87d10dd3686e">CallBackRef</a></td></tr>
<tr class="memdesc:af86e00e608392fe594cb87d10dd3686e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback reference for event handler.  <a href="#af86e00e608392fe594cb87d10dd3686e">More...</a><br/></td></tr>
<tr class="separator:af86e00e608392fe594cb87d10dd3686e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="struct_x_uart_psv.html" title="The XUartPsv driver instance data structure. ">XUartPsv</a> driver instance data structure. </p>
<p>A pointer to an instance data structure is passed around by functions to refer to a specific driver instance. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a4ac2e57dee932612cdc9eed25f025955"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUartPsv::BaudRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Current baud rate. </p>

<p>Referenced by <a class="el" href="group__uartpsv.html#gad9a82725de555ca0e6414d95afb4fb2a">XUartPsv_GetDataFormat()</a>, and <a class="el" href="group__uartpsv.html#ga8c73264d5304f3187edb896bab76dcb0">XUartPsv_SetBaudRate()</a>.</p>

</div>
</div>
<a class="anchor" id="af86e00e608392fe594cb87d10dd3686e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* XUartPsv::CallBackRef</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback reference for event handler. </p>

<p>Referenced by <a class="el" href="group__uartpsv.html#ga869ac0531d2e16457706d013d7f0a0cc">XUartPsv_InterruptHandler()</a>, and <a class="el" href="group__uartpsv.html#gafc24dc61fc253a957ba631fb53b5dfc8">XUartPsv_SetHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a28f121775b342f18caae6f39331d1079"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_uart_psv___config.html">XUartPsv_Config</a> XUartPsv::Config</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configuration data structure. </p>

<p>Referenced by <a class="el" href="xuartpsv__polled__example_8c.html#a34f772e363fbce111f8c84bf2be97750">UartPsvPolledExample()</a>, <a class="el" href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">XUartPsv_CfgInitialize()</a>, <a class="el" href="group__uartpsv.html#gad9a82725de555ca0e6414d95afb4fb2a">XUartPsv_GetDataFormat()</a>, <a class="el" href="group__uartpsv.html#gaaf3802ebc7d644ab9f80bb20060394e0">XUartPsv_GetFifoThreshold()</a>, <a class="el" href="group__uartpsv.html#ga049a65e8d28c43b51ce4c67b15a2d07e">XUartPsv_GetInterruptMask()</a>, <a class="el" href="group__uartpsv.html#ga9563569d26dcdc486b2fc9d2d18ec918">XUartPsv_GetModemStatus()</a>, <a class="el" href="group__uartpsv.html#ga2d87a5b4f9a733d6471c29080fddc7aa">XUartPsv_GetOperMode()</a>, <a class="el" href="group__uartpsv.html#ga30dc7c90e0cc1a859ae286f1bb4fb3cf">XUartPsv_GetOptions()</a>, <a class="el" href="group__uartpsv.html#ga869ac0531d2e16457706d013d7f0a0cc">XUartPsv_InterruptHandler()</a>, <a class="el" href="group__uartpsv.html#gaa335aef95c763728b0d179ddc3e8b209">XUartPsv_IsSending()</a>, <a class="el" href="group__uartpsv.html#gaa19ed118438249d9c56cd3afcfa8898c">XUartPsv_ProgramCtrlReg()</a>, <a class="el" href="group__uartpsv.html#gab7c628a4fd29e1f9d1d4cb9cbe672279">XUartPsv_ReceiveBuffer()</a>, <a class="el" href="group__uartpsv.html#ga5dba5d9d345ab578b8410113968ffaa6">XUartPsv_SelfTest()</a>, <a class="el" href="group__uartpsv.html#gac551c919a38424e6d23298256a9d1141">XUartPsv_Send_NoWait()</a>, <a class="el" href="group__uartpsv.html#ga2236ec3fe4acd721566be3025554826b">XUartPsv_SendBuffer()</a>, <a class="el" href="group__uartpsv.html#ga8c73264d5304f3187edb896bab76dcb0">XUartPsv_SetBaudRate()</a>, <a class="el" href="group__uartpsv.html#ga5947dc8794a2d6d1b5cfb7558a83ac4a">XUartPsv_SetDataFormat()</a>, <a class="el" href="group__uartpsv.html#gab2c5afc9fe98688f68d1eb52e5014401">XUartPsv_SetFifoThreshold()</a>, <a class="el" href="group__uartpsv.html#ga09b94a490c696d7ff7b1c6bbec42b226">XUartPsv_SetInterruptMask()</a>, <a class="el" href="group__uartpsv.html#ga0ea310ea61d052f2c4f5cce2dfadfc46">XUartPsv_SetOperMode()</a>, <a class="el" href="group__uartpsv.html#gada7b7128f09873d46fc19d0d9cf91751">XUartPsv_SetOptions()</a>, <a class="el" href="group__uartpsv.html#ga8bc7523050515544bb2823a9254ac8f5">XUartPsv_SetRxFifoThreshold()</a>, and <a class="el" href="group__uartpsv.html#ga43c4fde1105e2505e10c684622be1d13">XUartPsv_SetTxFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="aa64939340dd16487202fa1cc9a0af657"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__uartpsv.html#gab83b4279762a2b3f20b1c50998a709d3">XUartPsv_Handler</a> XUartPsv::Handler</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Function ptr to hold user handler. </p>

<p>Referenced by <a class="el" href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">XUartPsv_CfgInitialize()</a>, <a class="el" href="group__uartpsv.html#ga869ac0531d2e16457706d013d7f0a0cc">XUartPsv_InterruptHandler()</a>, and <a class="el" href="group__uartpsv.html#gafc24dc61fc253a957ba631fb53b5dfc8">XUartPsv_SetHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="a839fe00b54572bef26f9ecda4bd2a471"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUartPsv::InputClockHz</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Input clock frequency. </p>

</div>
</div>
<a class="anchor" id="a4dd385478a1d6f6dcbff3d0642ac1904"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XUartPsv::IsReady</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device is initialized and ready. </p>

<p>Referenced by <a class="el" href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">XUartPsv_CfgInitialize()</a>, <a class="el" href="group__uartpsv.html#gad9a82725de555ca0e6414d95afb4fb2a">XUartPsv_GetDataFormat()</a>, <a class="el" href="group__uartpsv.html#gaaf3802ebc7d644ab9f80bb20060394e0">XUartPsv_GetFifoThreshold()</a>, <a class="el" href="group__uartpsv.html#ga9563569d26dcdc486b2fc9d2d18ec918">XUartPsv_GetModemStatus()</a>, <a class="el" href="group__uartpsv.html#ga2d87a5b4f9a733d6471c29080fddc7aa">XUartPsv_GetOperMode()</a>, <a class="el" href="group__uartpsv.html#ga30dc7c90e0cc1a859ae286f1bb4fb3cf">XUartPsv_GetOptions()</a>, <a class="el" href="group__uartpsv.html#ga869ac0531d2e16457706d013d7f0a0cc">XUartPsv_InterruptHandler()</a>, <a class="el" href="group__uartpsv.html#gaa335aef95c763728b0d179ddc3e8b209">XUartPsv_IsSending()</a>, <a class="el" href="group__uartpsv.html#ga4d4d20bbcedb1de2adbe2644b821d12d">XUartPsv_Recv()</a>, <a class="el" href="group__uartpsv.html#ga5dba5d9d345ab578b8410113968ffaa6">XUartPsv_SelfTest()</a>, <a class="el" href="group__uartpsv.html#ga71a962de4963e15f1c38e7831e825f7c">XUartPsv_Send()</a>, <a class="el" href="group__uartpsv.html#gac551c919a38424e6d23298256a9d1141">XUartPsv_Send_NoWait()</a>, <a class="el" href="group__uartpsv.html#ga8c73264d5304f3187edb896bab76dcb0">XUartPsv_SetBaudRate()</a>, <a class="el" href="group__uartpsv.html#ga5947dc8794a2d6d1b5cfb7558a83ac4a">XUartPsv_SetDataFormat()</a>, <a class="el" href="group__uartpsv.html#gab2c5afc9fe98688f68d1eb52e5014401">XUartPsv_SetFifoThreshold()</a>, <a class="el" href="group__uartpsv.html#gafc24dc61fc253a957ba631fb53b5dfc8">XUartPsv_SetHandler()</a>, <a class="el" href="group__uartpsv.html#ga0ea310ea61d052f2c4f5cce2dfadfc46">XUartPsv_SetOperMode()</a>, <a class="el" href="group__uartpsv.html#gada7b7128f09873d46fc19d0d9cf91751">XUartPsv_SetOptions()</a>, <a class="el" href="group__uartpsv.html#ga8bc7523050515544bb2823a9254ac8f5">XUartPsv_SetRxFifoThreshold()</a>, and <a class="el" href="group__uartpsv.html#ga43c4fde1105e2505e10c684622be1d13">XUartPsv_SetTxFifoThreshold()</a>.</p>

</div>
</div>
<a class="anchor" id="aeee14c65e38a5fa3dc2eeaf6d60281ab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_uart_psv_buffer.html">XUartPsvBuffer</a> XUartPsv::ReceiveBuffer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to hold rx data. </p>

<p>Referenced by <a class="el" href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">XUartPsv_CfgInitialize()</a>, <a class="el" href="group__uartpsv.html#ga048adc3a5ea0979d28266476fa3960db">XUartPsv_CleanupRx()</a>, <a class="el" href="group__uartpsv.html#gab7c628a4fd29e1f9d1d4cb9cbe672279">XUartPsv_ReceiveBuffer()</a>, and <a class="el" href="group__uartpsv.html#ga4d4d20bbcedb1de2adbe2644b821d12d">XUartPsv_Recv()</a>.</p>

</div>
</div>
<a class="anchor" id="a52503eea4d30a82b0036bf8ee40980a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_uart_psv_buffer.html">XUartPsvBuffer</a> XUartPsv::SendBuffer</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Buffer to hold tx data. </p>

<p>Referenced by <a class="el" href="group__uartpsv.html#gae977262c7eae574f573fe4122ac6c0ab">XUartPsv_CfgInitialize()</a>, <a class="el" href="group__uartpsv.html#gaf1cde67fba29b14f65e5abe2dd7d2066">XUartPsv_CleanupTx()</a>, <a class="el" href="group__uartpsv.html#ga71a962de4963e15f1c38e7831e825f7c">XUartPsv_Send()</a>, <a class="el" href="group__uartpsv.html#gac551c919a38424e6d23298256a9d1141">XUartPsv_Send_NoWait()</a>, and <a class="el" href="group__uartpsv.html#ga2236ec3fe4acd721566be3025554826b">XUartPsv_SendBuffer()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
